home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d2 / timerun3.arc / TR.DOC < prev    next >
Text File  |  1989-09-22  |  12KB  |  349 lines
  1. TimeRun (c) Command Execution Facility, TR.EXE
  2.  Version 3.0 September 22, 1989
  3.  Copyright (C) 1987, 1988, 1989 Henry C. Clark
  4.  
  5. LICENSE INFORMATION
  6.  
  7. This program is NOT free.  It is copyrighted and protected under
  8. the laws of the State of Texas.
  9.  
  10. My time, my computers, my compilers and my function libraries are not
  11. free either.  The TimeRun (c) Command Execution Facility, Version 3.0,
  12. may be distributed freely under the following guidelines ONLY :
  13.   1) you do not alter the program
  14.   2) you do not receive money for anything related to the program
  15.      NOT EVEN THE DISKETTE ( they're so cheap nowadays )
  16.  
  17. If you personally are going to use TR.EXE, the TimeRun program,
  18. please send a license fee of U.S. 20 Dollars along with the
  19. registration form below to :
  20.  
  21.   Software Mechanics, TimeRun
  22.   P.O. Box 832052
  23.   Richardson, TX 75083
  24.   U.S.A.
  25.  
  26. You MUST register and pay the license fee if you use this program in
  27. a commercial environment or governmental organization.  Site licenses
  28. are available; refer to the registration form at the end of this
  29. document.
  30.  
  31. THERE IS NO WARRANTY IMPLIED WITH THE USE OF THIS PROGRAM.  THE
  32. ENTIRE RISK OF USING THIS PROGRAM IS YOUR'S EXCLUSIVELY, OBVIOUSLY.
  33.  
  34.  
  35. ------ Table of Contents
  36.  
  37. TimeRun (c) Command Execution Facility, TR.EXE
  38.  Version 3.0 September 22, 1989
  39.  Copyright (C) 1987, 1988, 1989 Henry C. Clark
  40.  
  41. 1.0  INTRODUCTION
  42. 2.0  INSTALLATION
  43. 3.0  USING TimeRun
  44. 3.1   COMMAND LINE PARAMETERS
  45. 3.2   RESULT MESSAGES
  46. 3.3   INCOMPATIBILITIES AND WARNINGS
  47. 4.0  THE TimeRun PROJECT
  48. 4.1   REGISTRATION FORM
  49.  
  50.  
  51. ------ 1.0  INTRODUCTION
  52.  
  53. TimeRun ( the program TR.EXE ) is a memory resident program which
  54. causes execution of one to ten DOS commands at some specified time
  55. in the future.
  56.  
  57. A good example of it's use can be found in a communications network
  58. monitor which runs on a PC.  The network requires monitoring between
  59. 7:00 AM and 19:00 ( 7 PM ), the monitor program being a PC based
  60. program.
  61.  
  62. TimeRun is used to start the monitor program at 7:00:00, and end the
  63. program at 19:0:0, and also to perform some housekeeping on the PC at
  64. 19:05:0.
  65.  
  66. TimeRun will monitor up to ten target times, and is compatible with
  67. all programs which use the DOS keystroke functions to get command
  68. characters.
  69.  
  70. Besides time of day operation, TimeRun will execute commands at
  71. specified intervals, and do so once or continuously.
  72.  
  73.  
  74. ------ 2.0 INSTALLATION
  75.  
  76. TimeRun is NOT copy protected.  Simply copy the TR.EXE file onto
  77. your normal work disk.  You run TR.EXE just like any other DOS command.
  78.  
  79. TimeRun Version 3.0 requires approximately 10 kilobytes of memory as
  80. a resident program.  When you install more than one target command,
  81. a second copy of TimeRun modifies the first and then exits.
  82.  
  83.  
  84. ------ 3.0 USING TimeRun
  85.  
  86. You run TR.EXE just like any other DOS command.  TimeRun requires
  87. parameters which are described in the following section.
  88.  
  89. TimeRun will always display an identifier message, and a result
  90. message based on it's ability to perform your request.
  91.  
  92. In general, the keyword "successfully" is used in a result message
  93. to mean that TimeRun has done something, as opposed to doing
  94. nothing.
  95.  
  96. TimeRun may be called from with batch files.  TimeRun returns with
  97. ErrorLevel = 0 upon successful operation, and ErrorLevel = 1 when it
  98. has not performed anything.
  99.  
  100.  
  101. ------ 3.1 COMMAND LINE PARAMETERS
  102.  
  103. TimeRun Version 3.0 has four parameter formats, three to install target
  104. commands, and another to request that TimeRun be removed from
  105. memory.
  106.  
  107. The general format of the target command installation command is :
  108.  
  109.   TR hh:mm:ss command [n,c]
  110.  
  111. The target time field, 'hh:mm:ss', is composed of a one or two digit
  112. hour ( 00 through 23 ) and a one or two digit minute ( 00 through 59
  113. ) and a one or two digit second separated by colons ( : ).  You may
  114. install more than one command using the same target time, and they
  115. will be executed in succession in the order installed.
  116.  
  117. The target command field, 'command', is any string up to 12
  118. characters in length.  The command field may be a single word or
  119. several words enclosed in quotes ( "command parm" ). If the command you
  120. require is longer than 12 characters, use a batch file or similar
  121. mechanism.  If you use "" with nothing inside,  TimeRun simply
  122. executes an <ENTER> key press.
  123.  
  124. Two options are available which modify the calculation of the target
  125. time for a command.  Either option may be specified, but not both (
  126. only the first will take affect ).  When using an option, the time
  127. field becomes an increment, not a time of day.
  128.  
  129.   'N' OPTION
  130.  
  131. The 'n' option causes the time field, 'hh:mm:ss', to become an
  132. INCREMENT value from the current time. For example, suppose it is
  133. exactly 8:00:00 when you enter the command :
  134.  
  135.   TR 0:1:0 dir n
  136.  
  137. TimeRun will execute the 'dir' command in exactly one minute, at
  138. 8:01:00.  Read the 'n' as 'IN', as in : execute a command IN so many
  139. hours, minutes and seconds".
  140.  
  141.   'C' OPTION
  142.  
  143. The 'c' option also causes the time field to become an INCREMENT
  144. value, but each time the command is executed,  a new target is
  145. calculated using the same INCREMENT time value.  For example, suppose
  146. you enter the command :
  147.  
  148.   TR 0:1:0 "" c
  149.  
  150. TimeRun will execute an <ENTER> in one minute, and once each minute
  151. after that, until TimeRun is removed from memory.  Unlike the 'n'
  152. option, which only installs a command to run once per day,  the 'c'
  153. option provides a way to execute commands continuously at a given
  154. interval.  Read the 'c' as 'CONTINUOUS', as in : execute a command
  155. EVERY so often, CONTINUOUSLY.
  156.  
  157. A time field value of 00:00:00 ( or 0:0:0 ) will mean midnight
  158. execution with no options,  immediate execution of the command using
  159. the 'n' option, and is an illegal time value for the 'c' option.
  160.  
  161. The format of the TimeRun remove from memory command is :
  162.  
  163.   TR -
  164.  
  165. Simply use the minus character ( - ), and TimeRun is removed from
  166. memory, which implies that no targeted commands will be executed.
  167.  
  168. If you have installed memory resident programs after TimeRun,
  169. removing TimeRun first will leave a hole in your memory map.
  170. ( So don't do that, remove them in reverse order ! )
  171.  
  172. Using the network monitor example from the introduction section,
  173. the following commands are used in the autoexec.bat file for the
  174. PC :
  175.  
  176.   TR 07:00:00 nminit
  177.   TR 19:00:00 "end netmon"
  178.   TR 19:05:00 nmclean
  179.  
  180. The command 'nminit' and 'nmclean' are batch files;  'end nm' is a
  181. command to the network monitor program.  Note that these time values
  182. will remain in effect for every day, until the PC is powered off
  183. or TR is removed from memory.
  184.  
  185. Another example is the keep-alive for a communications program. 
  186. Using the command :
  187.  
  188.   TR 0:1:0 "" c
  189.  
  190. before executing your communications program will generally cause
  191. the sending of an <ENTER> to the host computer.
  192.  
  193. ------ 3.2 RESULT MESSAGES
  194.  
  195. The following messages imply that TimeRun has performed some
  196. useful function :
  197.  
  198.   TimeRun successfully installed.   : TR resident and first target
  199.   TimeRun successfully added target.: second through tenth target
  200.   TimeRun successfully removed.     : '-' option, TR deinstalled
  201.  
  202. The following message is output when TimeRun is NOT called with
  203. the proper number or type of parameters.  Issuing the command TR
  204. with no parameters will generate this text as a help message :
  205.  
  206.      TR hh:mm:ss command [n,c]  installs a target command.
  207.     
  208.        hh hours, mm minutes, ss seconds must be specified.
  209.        options : n is increment time, c is continuous increment.
  210.     
  211.      TR -  removes TimeRun from memory.
  212.  
  213.  
  214. The following messages are TimeRun error reports and are self
  215. explanatory :
  216.  
  217.   Use 00 through 23 for hour value.
  218.   Separate hour from minute with a colon ':'.
  219.   Use 00 through 59 for minute value.
  220.   Separate minute from second with a colon ':'.
  221.   Use 00 through 59 for second value.
  222.   Unrecognized option.
  223.   Can't specify continuous increment of 00:00:00.
  224.   Max command length is 12 characters.
  225.   Target slots exceed 10 entries.
  226.   Can't install timer vector.
  227.   No copy of TimeRun to remove.
  228.   Can't remove TimeRun.
  229.  
  230. The following messages are run time errors, for which there are
  231. several causes, not to mention a bug in TimeRun.  Over one hundred
  232. tests have been performed with TimeRun, but your computer may be
  233. different. Be very careful when you see a message such as :
  234.  
  235.   Null pointer assignment.
  236.   Stack overflow.
  237.  
  238.  
  239. ------ 3.3 INCOMPATIBILITIES AND WARNINGS
  240.  
  241. TimeRun uses a technique called 'keyboard buffer stuffing' to send
  242. the target commands to DOS for interpretation and execution.  This
  243. method implies that programs which do not use the standard DOS
  244. key buffer character input functions will not receive commands.
  245. There were several applications programs that were not compatible,
  246. or which affected a delay in the TimeRun commands in previous
  247. versions of TimeRun.  I know of none at this time.  Send me a note
  248. if you run across one.
  249.  
  250. Further, because earlier versions of TimeRun were developed under
  251. earlier versions of DOS, this latest version may not be compatible
  252. with your system.
  253.  
  254.   Version 3.0 of TimeRun works for MS-DOS 3.31.
  255.  
  256. A keyboard enhancement program, such as CED, will receive target
  257. commands correctly, and TimeRun can issue a CED synonym.
  258.  
  259. TimeRun can call itself as long as the command is 12 characters or
  260. less ( which leaves little room for a command ) :
  261.  
  262.   TR 10:00:00 "TR 1:0:0 m c"
  263.  
  264. This is a way to place your continuous target commands on a 'even'
  265. time boundary.  Don't try to run a TimeRun command continuously
  266. because you will quickly run out of target slots.
  267.  
  268. TimeRun will not correctly execute special keystrokes, such as alt-
  269. or cntl- keys.  TimeRun is limited to pure character strings.
  270.  
  271.  
  272. ------ 4.0 THE TimeRun PROJECT
  273.  
  274. Version 1.0 - compiled with Microsoft C version 4.0 using Blaise C-Tools+
  275. 3.0, small model.
  276.  
  277. TimeRun is written entirely in C ( well, i didn't care to look at
  278. any library source code, thank you ) and suffers from extreme
  279. resident size because of the ordering of CODE and DATA segments by
  280. the compiler and libraries.
  281.  
  282. Version 2.0 - added time increment and continuous options, used
  283. Microsoft Asesmbler 4.0 to :
  284.   a. remove dead code after exit calls
  285.   b. use int 21 string output macro instead of puts()
  286.      NOTE to programmers :  this saved 3000 bytes.
  287.   c. replaced far memory library routines with ASM language code
  288.  
  289. Well, the result is two added features and a 6000 byte memory savings!
  290.  
  291. Version 3.0 - removed system idle checks to allow operation under
  292. DOS 3.3.  Hopefully, all those folks who were trying to use the old
  293. DOS 2.1 version will be statisfied.
  294.  
  295. Future :  It occurs to me that several new assembly language
  296. techniques can be used to further reduce the size of TimeRun in
  297. memory.
  298.  
  299.  
  300. /*------------------------------------------------------------------*/
  301. TimeRun Command Execution Facility
  302. Registration Form and Payment Invoice
  303.  
  304. PLEASE PRINT :
  305.  
  306. Name    _______________________________________
  307.  
  308. Address _______________________________________
  309.  
  310.         _______________________________________
  311.  
  312.         _______________________________________
  313.  
  314. Phone   _______________________________________
  315.  
  316.  
  317. Version ________________  Date Received ________________
  318.  
  319.  
  320. (  )  Enclosed is U.S. ____________ Dollars for ___________ copies
  321.  
  322.       of the TimeRun Command Execution Facility at
  323.  
  324.       U.S. 20 Dollars each.
  325.  
  326. (  )  Enclosed is U.S. ____________ Dollars for ___________ copies
  327.  
  328.       of customized TimeRun Command Execution Facility at
  329.  
  330.       U.S. 50 Dollars each.
  331.  
  332.       Enter customization parameters : ___________________________
  333.  
  334.       ____________________________________________________________
  335.  
  336. (  )  Enclosed is U.S.  1000        Dollars for  50 or more  copies
  337.  
  338.       of the TimeRun Command Execution Facility, site license.
  339.  
  340.  
  341. Send this form with check or money order to :
  342.  
  343.   Software Mechanics, TimeRun
  344.   P.O. Box 832052
  345.   Richardson, TX 75083
  346.   U.S.A.
  347.  
  348. /*------------------------------------------------------------------*/
  349.